home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 49 / Amiga Format CD49 (2000-01-17)(Future Publishing)(GB)(Track 1 of 3)[!][issue 2000-02].iso / -serious- / misc / mmu_update / readme < prev    next >
Text File  |  1999-11-30  |  58KB  |  1,393 lines
  1. The mmu.library project © 1998,99 the mmu.library development group, THOR
  2. -----------------------------------------------------------------------------
  3.  
  4. Release 40.60
  5. -------------
  6.  
  7.     - fixed the shutdown code of MGA, thanks to Stephan!
  8.     - disabled a kludge in the mmu.library which write protected 
  9.       a kickstart image at 0x00200000 and up by checking the name 
  10.       of execbase. This kludge might have conflicted with some softkickers.
  11.     - Because people tend not to read guides, I added the 
  12.       arguments "WRITEPROTECTED" and "INVALID" to the library build-in 
  13.       "SetCacheMode". Note that they work different to what "MuSetCacheMode" 
  14.       does. Here, "WRITEPROTECTED" and "INVALID" are just aliases to "ROM" 
  15.       and "BLANK", hence enable the most defensive protection strategy.
  16.     - Added a new LVO "RebuildTreesA" which is "officially" not yet 
  17.       existing and will be documented in V41. More LVOs might be added up 
  18.       to V41, but please *DO NOT* yet call them as they did not exist 
  19.       in V40.50.
  20.     - Fixed the installation script, due to a typo the P5 MMU boot hack 
  21.       was not detected.
  22.     - Fixed the P5Detect program which just looked to the wrong
  23.       identification resources. Ooops. Installation on "non-standard"
  24.       boards should be smoother now.
  25.     - Fixed a bug in the disassembler.library which disassembled the
  26.       lea (offset.L,pc)
  27.       wrong. The offset was wrong by two bytes.
  28.     - The release number in the MuForce guide was wrong. 
  29.     - When will people finally learn to read the FAQ? *Sigh*
  30.       In case MuFastZero complains "The zero page is already remapped",
  31.       ---> READ THE GUIDE. <---
  32.  
  33.  
  34. Release 40.51.1
  35. -------------
  36.  
  37.     - disabled the layers.library kludge for MuGuardianAngel if V40
  38.       is found active. It is luckely no longer required.
  39.  
  40. Release 40.51
  41. -------------
  42.  
  43.     - fixed a bug in the 68060 startup logic which left the MMU disabled
  44.       in case it was disabled before. This made the custom 68060.library
  45.       useless.
  46.     - included the 40.17ß3 release of Carten Schlote's 68060.library
  47.       which (for the first time) makes use of the MMU.library.
  48.  
  49. Installation of this library requires some care as IT DOES NOT automatically
  50. auto-detect P5 hardware and special setup magic for this hardware. This is
  51. not because the library is "broken" in some sense, but because P5 didn't 
  52. follow the CBM guidelines when designing their hardware. Therefore, an
  53. experimental installation script has been written. This script must be
  54. run as follows:
  55.  
  56.     - Unpack the archive to disk,
  57.     - Enter the following commands:
  58.  
  59. cd <MMULib>/Install    ;where <MMULib> is the directory you unpacked this 
  60.             ;archive to
  61.  
  62. SYS:Rexxc/rx BuildMMUConfig.rexx ENVARC:MMU-Configuration
  63.  
  64.     - The last command builds the MMU configuration and writes it
  65.       to ENVARC:MMU-Configuration. It might also copy ScanMMUPort
  66.       to LIBS:MMU. This is an external setup command for the library
  67.       and might or might not be required. Older P5 hardware does *not*
  68.       require it (I would guess that this is explicitly for the 
  69.       Blizzards, but I'm not sure).
  70.       Non-P5 hardware will not require it at all.
  71.       You might want to hand-edit or optimize this script if you need,
  72.       as it will contain several optimizations for graphics cards and
  73.       other known boards.
  74.  
  75.     - KEEP THE OLD 68060.library IN A SAFE PLACE.
  76.     - Make sure to install the 40.51 edition of the mmu.library
  77.     - Copy the 68060.library to LIBS:
  78.     - Reboot the computer and wish the new library luck. (-:
  79.  
  80. This edition of the '060 lib does *not yet* include correct VMM management
  81. and FPU control functions (hence, C:FPU will not yet work). It is shorter
  82. and costs less memory because it leaves the MMU setup to the mmu.library.
  83. (Note that this release contains still debugging information).
  84.  
  85.  
  86. In case the installation failed:
  87.  
  88.     - Make sure the mathieedoubbas.library you're using is truely the
  89.       official 38.x or the patched and bugfixed 39.1. Some other third-
  90.       party products may fail to work correctly if the 68060 support
  91.       code is not yet loaded.
  92.  
  93. In case running the library fails (i.e. system doesn't boot):
  94.  
  95.     - Make sure LIBS:mmu/ScanMMUPort is really available at boot-up
  96.     - Please re-boot the computer without the startup-sequence,
  97.     - Keep ENVARC:MMU-Configuration in a safe place,
  98.     - Re-install the old 68060.library.
  99.     - Boot the computer again,
  100.     - Run "MuScan" and keep the output.
  101.  
  102. Then, please sent me the output of MuScan, and the ENVARC:MMU-Configuration
  103. file with a tiny note what exactly happened (or did not happen).
  104.  
  105.  
  106. Release 40.50
  107. --------------
  108.  
  109.     - added external command scanning in case a setup command is
  110.       not found "resident".
  111.     - included Richard Körber's PatchWork and Olaf Barthel's
  112.       Sashimi. The "PatchWork" edition is *NEW* and *NOT YET AVAILABLE*
  113.       otherwise. Big "thank you" to Richard for updating it for this
  114.       archive. Big thanks to Olaf Barthel for allowing me to include
  115.       his "Sashimi" in the archive.
  116.     - bumped the version number.
  117.     - Final release.
  118.  
  119. Release 0.48
  120. --------------
  121.     - mmu.library: Added a new command in the MMU-Configuration file,
  122.       "DescriptorCacheInhibit". It controls whether the MMU library
  123.       should disable the data cache for the descriptors. This is by
  124.       default OFF as this feature means more trouble for the library,
  125.       and is not required for using the library. However, this might
  126.       be a workaround for programs that hack the MMU table themselves,
  127.       which is not supported anyhow. Set it to "ON" if you MUST use
  128.       these programs.
  129.     - Added another VMM support function.
  130.     - MuGuardianAngel: The "memory header" output was broken, fixed.
  131.       Added more security checks, MuGuardianAngel will warn you in
  132.       case its function entries have been patched (which is not 
  133.       supported)
  134.     - MuGuardianAngel: Added automatic stack checking within the
  135.       memory allocation functions - an overrun stack seems to be the
  136.       most common source of MuGuardianAngel problems. MuGuardianAngel
  137.       will now detect an "nearly out of stack" condition in the memory
  138.       handling, and will provide an "emergency" stack in case this
  139.       happens. It will then generate a warning, regardless of whether    
  140.       stack snooping is enabled or not.
  141.       Interestingly, the RAM-Handler and the FastFilingSystem are the
  142.       most common sources of stack-overflows. This should be fixed for 
  143.       the RAM handler with "PatchRAM" in this archive, the FFS stack
  144.       should be added manually in the RDB, though. The smallest re-
  145.       commended stack size is 786 bytes, not less!
  146.     - P96: (yes, you read this correctly) supports now the mmu.lib if
  147.       it is available.
  148.     - Added an experimental GfxCard setup program to optimize cacheing.
  149.       This function is included in P96 anyhow, so not really required.
  150.  
  151.     - mmu.library: MOVE16 is now "sort of" supported, in the sense that
  152.       the exception handler will be able to handle it. However:
  153.       - MOVE16 is not supported by all Amiga hardware, it may crash,
  154.       - A MOVE16 on a 68040 is potentially dangerous due to a bug in
  155.         the CPU. A MOVE16 might invalidate cache lines which are not
  156.         related to the MOVE16 operation at all. There is currently a
  157.         workaround for this, namely: Do not set the "imprecise", or
  158.         "user page" bits 0-3 for swapped, invalid or supervisor only
  159.         pages. I do not guarantee that this workaround will remain
  160.         valid. *JUST DON'T USE MOVE16.*
  161.       - A MOVE16 may cause double reads, do not use this to read from
  162.         hardware registers that cannot tolerate this. Do NOT use it
  163.         at all!
  164.       - A MOVE16 which causes the exception handler to enter may be
  165.         completed by means of ordinary writes, which means that in
  166.         this situation no burst access is used, and the order of the    
  167.         data written out or read might be different from that of a
  168.         true MOVE16. *JUST DO NOT USE IT, OK!*
  169.  
  170.     - mmu.library: On read/modify/write accesses, the library might
  171.       have reported a write protection fault instead of a simple 
  172.       write fault on the write cycle of the instruction. Fixed.
  173.  
  174.     - MuGuardianAngel: Added more consistency checks, added checks
  175.       and support for memory pools, made some error messages more
  176.       informative.
  177.  
  178.     - MuMove4K: Added the NOREBOOT option to avoid unnecessary reboots
  179.       if the system is rebooted by a second program afterwards anyhow.
  180.  
  181.     - Included a patch for the V44 SetPatch.
  182.  
  183. Release 0.47
  184. --------------
  185.     - mmu.library: Changed again the cache control logic a bit. Please
  186.       try DMA transfers again. The new logic does not block interrupts
  187.       as long as the old logic, hence might avoid problems if fast
  188.       interrupt processing is required. It should be *slightly* faster
  189.       as well.
  190.     - MuForce: MuForce catches now supervisor exceptions as well if you
  191.       specify the "CAPTURESUPER" keyword. This requires patching of
  192.       some autovectors.
  193.     - Added a new drawer "Contributions", containing more tools from
  194.       other people I regard as very useful. This is "Sashimi" by
  195.       Olaf Barthel, and "PatchWork" by Richard Körber. Thanks Olaf,
  196.       thanks Richard for allowing me to include your great work!     
  197.     - Run all guides thru ISpell, hopefully correcting most typos.
  198.     - MuMove4K: The PREPAREEMUL option disabled the CPU instruction
  199.       cache. I expected the ROM would re-enable it somewhat later, but
  200.       it didn't. Fixed.
  201.  
  202. Release 0.46
  203. --------------
  204.     - mmu.library: Found that the "ramlib" task is really very low on
  205.       stack. I'm now swapping the stack on library startup to avoid
  206.       problems.
  207.     - updated the mmu.lib exception handler. It is now possible to use
  208.       the exception mechanism to auto-extend the stack and to keep the
  209.       user stack on virtual memory. The new "message hook" mechanism
  210.       does not require user stack space. However, an additional patch
  211.       to the exec switch function is required for this trick. This
  212.       patch is currently not included in the mmu.library - basically
  213.       because this is not directly MMU related.
  214.     - MuGuardianAngel will now stop to check for a valid free memory
  215.       counter if it finds a problem and reports the problem immediately.
  216.     - MuForce is now able to capture even "ordinary" MC68K exceptions.
  217.       This can be disabled with the new "NOGURUPATCH" option.
  218.     - Included a "synchronous" version of the 680x0.library because the
  219.       asynchronous outsmarted several systems.
  220.     - mmu.library: The chip ram is now by default marked as cacheinhibit 
  221.       imprecise nonserialized. This will speed up chip ram access a bit
  222.       for the 68060 and 68040. Works of course only if the MMULib is
  223.       used to setup the MMU tables, i.e. for users of the V40 68040 lib.
  224.       Video RAM of several graphics cards can be setup in the same way
  225.       as well, but since there's no way to identify expansion hardware as
  226.       video ram, you've to do that manually.
  227.     - mmu.library: The F-Space is now by default marked as cacheinhibit
  228.       to allow (IMHO misdesigned) hardware to map in here without telling
  229.       the system. This can be disabled by using the MMU-Configuration
  230.       file.
  231.     - Added a new MuTool: MuFastChip. This tool will enable the imprecise
  232.       or nonserialized cache mode for chip memory and will hence improve
  233.       chip memory access performance for systems where a third-party 040 
  234.       or 060 library does not setup the MMU tables in the optimal way.
  235.       The MMU.library (and hence the V40 68040.lib) *will* build its own
  236.       MMU tables with this feature enabled anyhow if it doesn't find an
  237.       MMU table to start from. 
  238.     - Fixed the SetPatch fix. (You kept the original, right? :-)
  239.       It might have been that the 43.7 edition installed a fix for the
  240.       mathieeesingbas.library even if this fix is unnecessary and fatal,
  241.       as it is for the 68881/68882 FPU.
  242.  
  243. Release 0.44
  244. --------------
  245.     - mmu.library:    The "AddMem" command in the MMU-Configuration file
  246.       was broken. Added the memory twice, causing nothing but a mess.
  247.     - Added a safety check for "AddMem", the command is now ignored
  248.       in case the memory in question is already added.
  249.     - "SetCacheMode" argument "valid" was broken and did not validate
  250.       the memory at all.
  251.     - AddMem'd memory was added after the MMU table setup, hence wasn't
  252.       used for the MMU descriptors. The library *tries now* to add it
  253.       as soon as possible to make some use of it for building the MMU
  254.       trees.
  255.     - MuFastZero: The FORCENATIVE option generated a failure code in
  256.       case the zero page wasn't remapped, stopping additional options
  257.       like MOVESSP from working.
  258.     - MuGuardianAngel: The "MemHeader free counter incorrect" error
  259.       handler did not save back one register and hence caused additional
  260.       hits.
  261.     - MuGuardianAngel: Ooops, found a problem of the RAM-Handler. Not
  262.       a MuGuardianAngel problem, but a real design fault of RAM: DO NOT
  263.       try to delete and write to the RAM: disk at the same time, this
  264.       will cause lots of trouble.
  265.     - Included a fix for the CBM mathieeedoubbas.library 38.2. This
  266.       library fails to compare floating point numbers below zero
  267.       correctly in some cases. The P5 library patches mathieeedoubbas
  268.       to fix this, but the 68040.library should not be a replacement
  269.       for SetPatch. To apply the patch,
  270.  
  271. 1)      Copy the file LIBS:mathieeedoubbas.library to RAM:
  272. 2)      Copy the file mathieeedoubbas.pch in the directory "Fixes" to RAM:
  273. 3)      Copy the "spatch" program at the same place to RAM:
  274. 4)      Change the directory to ram: with "cd RAM:"
  275. 5)      Apply the patch with    "spatch mathieeedoubbas.library"
  276. 6)      Copy the file RAM:mathieeedoubbas.new to
  277.         LIBS:mathieeedoubbas.library. It contains the fixed library.
  278.  
  279.     - In case the V40 68040.library slowed your computer down:
  280.       copy the file "MMU-Configuration" from the "ENVARC" drawer into
  281.       "ENVARC:". In case this causes crashes with Z-II memory, follow
  282.       the instructions in the file and remove one semicolon in front of
  283.       the "SetCacheMode" command. 
  284.     - Removed the debugging information from all files.
  285.     - Added the MMU master guide. Please check this, is this understand-    
  286.       able? In case I forgot to mention you in the credits, please let
  287.         me know!
  288.     - Moved all libraries to a separate directory, "Libs"
  289.     - Included a new library, the 680x0.library. This is the CPU
  290.       unspecific CPU driver. It's job is to detect which CPU is avail-
  291.       able in your system, and to load the CPU specific code. It there-
  292.       fore acts very much like the P5 68040dummy.library, except that
  293.       it remains in the system and provides user-callable function
  294.       entries for querying the CPU/FPU/MMU type and to setup the FPU
  295.       exceptions. The CPU specific library *should never be called
  296.       directly*, this library will re-route the calls to the correct
  297.       library. Furthermore, it loads the library in background, helping
  298.       to speed up the boot process a bit. 
  299.     - A special edition of SetPatch is available that loads the 680x0
  300.       library instead the 68040.library, regardless of which processor 
  301.       is available. The 680x0.library will then even try to load an
  302.       68000.library or 68020.library. This library could be used, for
  303.       example, to install line-F instructions to emulate the FPU 
  304.       completely in software, even for a 68020 or 68000 without FPU.
  305.       To patch "SetPatch", 
  306.  
  307. 0)    Keep a copy of SetPatch in a safe place.
  308. 1)      Copy the file C:SetPatch to RAM:
  309. 2)      Copy the file SetPatch.pch in the directory "Fixes" to RAM:
  310. 3)      Copy the "spatch" program at the same place to RAM:
  311. 4)      Change the directory to ram: with "cd RAM:"
  312. 5)      Apply the patch with    "spatch SetPatch"
  313. 6)      Copy the file RAM:SetPatch.new to C:SetPatch. This is the
  314.     inofficial 43.7 edition of SetPatch.
  315.  
  316.     - Included a new program, "FPU" in the "Shell only" drawer. This
  317.       program controls the exception generation of the FPU. It will
  318.       only work with the 680x0.library and the V40 68040.library
  319.       installed.
  320.  
  321.  
  322. Release 0.42
  323. --------------
  324.     - 68040.library: Only cosmetic changes. Added a AN_Zombie guru in
  325.       case the ColdReboot() function returned. I've no idea how this
  326.       could happen.
  327.     - mmu.library: I don't thrust the AFF_68060 flag any more. The
  328.       68060.library of the LC75 Apollo board does not set this bit
  329.       correctly and hence identifies the 060 as 040. Hence, the library
  330.       tried to install the wrong driver and crashed desparately. The
  331.       library tries now to identify an 060 in case at least an 040 is
  332.       indicated. The library updates then its own AttFlags copy 
  333.       correctly. Outch! I don't know whether this is a typo in the
  334.       sources of the 68060.lib, or this intended and something "sneaky"
  335.       I fail to understand. 
  336.     - Fixed one bug in the disassembler.library. It failed to disassemble
  337.       64 bit arithmetics correctly.
  338.     - MuFastRom: In case no argument is given, the program uses now the
  339.       default "On".
  340.     - MuFastZero: Again, made "On" the default argument. Added the
  341.       "MoveSSP" and "StackSize" arguments to relocate the supervisor
  342.       stack to fast ram. This does not make use of the MMU.
  343.     - Added the "CheckFPU" command, in the "Shell_Only" drawer. This
  344.       program prints the version number of a 68040 FPU if one is avail-
  345.       able. Two versions exist, the V40 "original" which is very buggy
  346.       and the V41 "revised" with less bugs. The 68040.library supports
  347.       currently both, with lots of workarounds for the V40. Please
  348.       contact me in case you find a V40 edition in your Amiga.
  349.     
  350.  
  351. Release 0.41
  352. --------------
  353.  
  354.     - Forgot to update the version number in 0.40. Reported 0.38. Oops.
  355.     - TTx parsing was still not 100% correct, but much better. Fixed.
  356.     - Due to a typo, branch cache flushes were effectively disabled.
  357.       Outch! Forgot one single "$".
  358.     - Added branch cache flushes on context switches, recommended by
  359.       Motorola.
  360.     - Added includes, autodocs and .fd files for the 68040.library.
  361.     - Updated MuFastZero and MuFastROM to include and set the cache
  362.       flags according to the mirrored RAM. This is of importance in
  363.       case non-cacheable Z-II fast RAM is used to build the mirror.
  364.     - Made mild modifications to the FPSP FPU emulator package to speed
  365.       it up a bit. The 40.1 release is now unnoticably faster than the
  366.       Mike Sinz 37.30 release, which is again unnoticably faster than
  367.       the P5 release.
  368.     - Added a workaround in GetMsg() to keep some brain-dead programs
  369.       working that call GetMsg() in a tight loop without giving
  370.       interrupts a chance to occur. These programs tend to block the
  371.       computer completely, especially if the ROM is remapped to 
  372.       cacheable, burstable memory. The workaround is a single NOP.
  373.  
  374. Release 0.40
  375. --------------
  376.     New in this release:
  377.  
  378.     - Added four internal undocumented LVOs for external CPU drivers.
  379.     - Fixed a bug in the CPU detection routine. A 060 EC or LC was
  380.       not recognized. Outch! Which smart guy at Motorola decided to use
  381.       the same processor ID for both products? The EC doesn't have a MMU,
  382.       the LC - as for example used by the LC75 Apollo board - does.
  383.       This might well explain a lot of problems of the Apollo board....
  384.     - Fixed a bug in the library init routine which would cause a guru
  385.       in case no MMU is available at all. The library MUST load, and
  386.       some functions will be available even without an MMU.
  387.     - Fixed several minor bugs of the TTx parsing routine, hopefully
  388.       correcting problems with some ancient 040 library releases that
  389.       didn't make use of the MMU (how should that work?)
  390.     - Fixed a serious bug of the Alert() replacement function, the stack
  391.       was used plain wrong. Thanks Etienne!
  392.     - Included an updated and more streamlined version of MuLockLib,
  393.       thanks to Gunther Nikl for providing it.
  394.     - Updated MuSetCacheMode, added more options.
  395.     - Added a configuration/preferences file and a preferences file
  396.       parser.
  397.     - Included now the "stripped" versions of the libraries in a sub-
  398.       directory of the same name. These editons don't contain the de-
  399.       bugging information and are therefore shorter.
  400.     - *News flash* 
  401.       This release comes with an upgraded version of the 68040.library.
  402.       This library is still in "beta" stage, but makes already use of
  403.       the mmu.library for the MMU configuration. It is for that reason
  404.       even shorter than the 37.30 release, even though it uses the latest
  405.       68040 FPU emulation code from Motorola.
  406.       FPU exceptions are configurable thru an LVO vector of the library,
  407.       but I haven't written a control tool yet. This will follow in the
  408.       next distribution.
  409.       This release *will only work* if the 37.30 runs on your machine,
  410.       you should, however, edit the ENVARC:MMU-Configuration file to 
  411.       to make some P5 boards working. The file should contain this line:
  412.  
  413. SetCacheMode    from 0x00f00000 size 0x00080000 valid iospace
  414.  
  415.       If you use this edition of the 68040.library, it might disable
  416.       caches for the Z-II address space completely. If this is not
  417.       desired, you may turn them on again with the following line in
  418.       the MMU-configuration file:
  419.  
  420. ClearTTX    
  421.  
  422. The path of the preferences file is ENV:MMU-Configuration or 
  423. ENVARC:MMU-Configuration if the first file is not found. The file looks like
  424. a standard shell script except that only three commands are known. All
  425. other commands are ignored silently for forwards compatibility, more might
  426. be made available in the future. The semicolon is used to separate comments 
  427. from the commands, the text following a semicolon is ignored.
  428.  
  429. The following three commands are available:
  430.  
  431. ClearTTX    ITT0/S,ITT1/S,DTT0=TT0/S,DTT1=TT1/S,ALL/S
  432.  
  433.     Controls the mmu.library use of the transparent translation registers.
  434.     By default, they are considered, their setup is added to the MMU
  435.     tree layout and they are cleared afterwards. Using this command,
  436.     several TTx registers can be made to be ignored (even though they
  437.     are still cleared because they are "in the way")
  438.  
  439.     ITT0        Ignore the instruction transparent translation 
  440.             register 0. (68040 and 68060 only).
  441.     ITT1        Ignore ITT1 (68040 and 68060 only).
  442.     DTT0        Ignore the data transparent translation register
  443.             number 0 (68040 and 68060) or the transparent
  444.             translation register 0 (68030).
  445.     DTT1        Ignore DTT1 (68040 and 68060) or TT1 (68030)
  446.     DTT0        Ignore DTT0
  447.  
  448.     ALL        Ignore all TTx registers. This is the default if
  449.             no other options are given.
  450.  
  451.     This command does nothing on a 68851 because this MMU doesn't offer 
  452.     transparent translation registers at all.
  453.  
  454.  
  455. AddMem        FROM=ADDRESS/A,LENGTH=SIZE/A,ATTR=FLAGS/K,PRI/K,NAME/K
  456.  
  457.     Adds memory to the exec memory pool. Note that THIS DOES NOT
  458.     make the memory available, i.e. it is NOT AUTOMATICALLY marked
  459.     as "valid". Hence, an "AddMem" command requires most likely a
  460.     "SetCacheMode" for the same memory region or the library will
  461.     crash on startup.
  462.  
  463.     FROM=ADDRESS    Base address of the memory to be added. in hex
  464.             notation. A leading $ or 0x is allowed.
  465.             This address must be aligned to a 64K boundary.
  466.  
  467.     LENGTH=SIZE    Size of the memory to be added in bytes, in hex.
  468.             Again, must be divisible by 64K.
  469.     
  470.     ATTR=FLAGS    Memory attribute flags in hex. Defaults to 0x05
  471.             which is MEMF_PUBLIC|MEMF_FAST. More flags are
  472.             documented in exec/memory.h. The library *does not*
  473.             know the nmemonics for the memory types, though.
  474.  
  475.     PRI        Priority of the memory pool to be added, in decimal
  476.             notation. This must be a number between -128 and 127. 
  477.             Defaults to six.
  478.  
  479.     NAME        Name of the memory pool. 
  480.             Defaults to "MMU expansion memory".
  481.  
  482.     Again, this command *does not* make the memory available for the
  483.     processor, an additional "SetCacheMode" is required.
  484.  
  485.  
  486. SetCacheMode    FROM=ADDRESS/A,LENGTH=SIZE/A,
  487.         COPYBACK/S,WRITETHROUGH/S,CACHEINHIBIT/S,
  488.         NONSERIAL/S,IMPRECISE/S,
  489.         VALID/S,BLANK/S,
  490.         IO=IOSPACE/S,NOIO=NOIOSPACE/S,
  491.         ROM/S,NOROM/S
  492.  
  493.     This is a "cut down" version of the "MuSetCacheMode" command, it
  494.     supports a sub-set of its cache control commands. Options that
  495.     modify memory in a way that could result in access errors are not
  496.     supported and must be setup by hand with "MuSetCacheMode".
  497.  
  498.     FROM=ADDRESS    The base address of the memory region whose cache
  499.             mode shall be changed. This is in hex notation, a
  500.             leading 0x or $ is allowed.
  501.             The library will round this down to the next
  502.             page size boundary, which is usually 4K or 1K.
  503.  
  504.     LENGTH=SIZE    The size of the memory region in bytes, in hex
  505.             notation. 
  506.             The library will round this up to the next page
  507.             size if required.
  508.  
  509.     COPYBACK    Enables the copyback cache mode. This is the
  510.             fastest cache mode available, reads and writes are
  511.             cached if the CPU allows this. This option will 
  512.             fall back to WRITETHROUGH on a 68030 or 68851.
  513.  
  514.     WRITETHROUGH    Enables the writethrough cache mode. Reads will
  515.             be cached, writes will enter the cache but will be
  516.             written out to memory as well.
  517.  
  518.     CACHEINHIBIT    Disables the cache completely.
  519.  
  520.     NONSERIAL    Disables the cache, but allows the CPU to reorganize
  521.             accesses to speed up memory transfers a bit. 
  522.             (68040 only, does nothing on all others).
  523.  
  524.     IMPRECISE    Disables the cache, but allows the CPU to handle
  525.             access errors a bit "sloppy" to speed up access a
  526.             bit. (68060 only, does nothing on all others).
  527.  
  528.     VALID        Validates the memory region, i.e. makes it available.
  529.             This option is required to enable a memory region
  530.             that should be added to the exec memory pool by the
  531.             "AddMem" command.
  532.  
  533.     BLANK        Invalidates the memory region, all accesses will be
  534.             remapped to a "dummy" page.
  535.  
  536.     IO=IOSPACE    Marks the memory region as mapped IO space, and
  537.             sets the cache mode to CACHEINHIBIT. The cache mode
  538.             can be overridden by using the cache control options.
  539.  
  540.             This is a pure software flag which is, however, used            
  541.             by MuForce and friends. Memory marked as IOSPACE is
  542.             never disassembled or dumped because of undesireable
  543.             side effects that might result.
  544.  
  545.     NOIO=NOIOSPACE    Marks the memory as plain RAM space, negative form of
  546.             IO=IOSPACE.
  547.  
  548.     ROM        Marks the memory as ROM space and enables the
  549.             defensive write protection. Writes to this area will
  550.             be ignored silently.
  551.  
  552.     NOROM        Marks the memory as RAM space, writes are allowed.
  553.             Negative form of NOROM.
  554.  
  555.  
  556. For example, to add non-autoconfiguring fast cacheable memory 
  557. from 0x02000000 to 0x03ffffff, setup your "MMU-Configuration" as follows:
  558.  
  559. SetCacheMode    from 0x02000000 size 0x01000000 valid copyback
  560. AddMem        from 0x02000000 size 0x01000000
  561.  
  562. --
  563. To disable the cache of autoconfiguring Zorro-II memory, as required by
  564. some 040 and 060 based boards that can't break up burst accesses into
  565. 16-bit Z-II accesses:
  566.  
  567. SetCacheMode    from 0x00200000 size 0x00800000 cacheinhibit
  568.  
  569. The GVP Combo 040 is an example for a board requiring this "adjustment".
  570.  
  571. --
  572. To mark non-autoconfiguring hardware in the F-Space as "IO space":
  573.  
  574. SetCacheMode    from 0x00f00000 size 0x00080000 iospace
  575.  
  576. Most P5 boards suffer from this design problem.
  577.  
  578.  
  579. Release 0.38
  580. --------------
  581.     New in this release:
  582.  
  583.     - Added four internal undocumented LVOs for external CPU drivers.
  584.     - Fixed a bug in the CPU detection routine. A 060 EC or LC was
  585.       not recognized. Outch! Which smart guy at Motorola decided to use
  586.       the same processor ID for both products? The EC doesn't have a MMU,
  587.       the LC - as for example used by the LC75 Apollo board - does.
  588.       This might well explain a lot of problems of the Apollo board....
  589.     - Fixed a bug in the library init routine which would cause a guru
  590.       in case no MMU is available at all. The library MUST load, and
  591.       some functions will be available even without an MMU.
  592.     - Fixed several minor bugs of the TTx parsing routine, hopefully
  593.       correcting problems with some ancient 040 library releases that
  594.       didn't make use of the MMU (how should that work?)
  595.     - Fixed a serious bug of the Alert() replacement function, the stack
  596.       was used plain wrong. Thanks Etienne!
  597.     - Included an updated and more streamlined version of MuLockLib,
  598.       thanks to Gunther Nikl for providing it.
  599.  
  600. Release 0.37
  601. --------------
  602.     New in this release:
  603.  
  604.     - Added two tags for Get/SetContextData in preparation for the
  605.       memory library.
  606.     - Wrote a replacement AddMemList() function because some 
  607.       versions of the 68040/68060.library functions patch this function.
  608.       This release will adjust the MMU tables for the DEFAULT CONTEXT
  609.       only, which means that all memory must be ready AT LEAST AS SOON
  610.       AS A PRIVATE CONTEXT IS CREATED.
  611.  
  612.  
  613. In case you've problems with this library release:
  614. o) Please install the mmu.library_debug ON TOP of the mmu.library, i.e. use
  615.  
  616. copy mmu.library_debug to LIBS:mmu.library
  617.  
  618. o) Reset the system
  619. o) Run Sushi or Sashimi to fetch the output. Give them a HUGE buffer
  620. o) Load the library. MuLockLib would do that, for example.
  621.  
  622. Release 0.36
  623. --------------
  624.     News in this release:
  625.  
  626.     - Fixed MuMove4K, added the A1200 option and fixed the shutdown code.
  627.     - Fixed MuLockLib, there was a slight chance for a crash (thanks to
  628.       Gunther Nikl for reporting)
  629.     - Fixed the .fd-File. I forgot to include two functions making
  630.       the table useless, and forgot to include one library 
  631.       function in the library lvo jump table. Outch!
  632.     - Fixed the new memory map functions.
  633.     - Tested indirect descriptor functions, included a new test,
  634.       see MuIndirectTest.
  635.  
  636. I'm planning to upload the 0.36 to the Aminet next saturday, I won't be in
  637. town from July 18th to August 8th. 
  638.  
  639. Release 0.35
  640. -------------
  641.     News in this release: Something in the library, even though no
  642.     real serious bugs have been found. More functions, but more power-
  643.     ful debugging tools.
  644.  
  645.     - Added support functions for memory maps, likely untested.
  646.     - Added support functions for indirect descriptors and *VERY FAST*
  647.       indirect page swapping.
  648.     - Fixed a tiny bug in the 060 support which might have failed to
  649.       detect physical bus errors correctly.
  650.     - Fixed a bug in GetPageProperties which might have failed to
  651.       read remapped memory correctly.
  652.     - Streamlined the tag item parse functions.
  653.     - Updated documentation and includes.
  654.     - Wrote the disassembler.library, added to the distribution.
  655.     - Updated MuForce: The program makes use of the disassembler.library
  656.       and prints now a disassembly of the faulty code on demand.
  657.     - Fixed a bug in MuGuardianAngel, stack dump was broken.
  658.     - Updated MuGuardianAngel, included disassembly function.
  659.     - Updated MuMove4K a lot, included a PREPAREEMUL function,
  660.       wrote a better guide, drew a shell icon.
  661.     - Included more shell tools, PrintBusError, ResetBusError and
  662.       ClearTTx.
  663.  
  664. The Apollo LC060 75Mhz showed problems with the mmu.library. I don't know
  665. how these problems arose, but it might be that the MMU doesn't like the over-
  666. clocking. To test this, please run the "ClearTTx" program with the NATIVE
  667. Apollo setup and check whether this works or not.
  668.  
  669. The PrintBusError tool will dump the bus error vector. It should always
  670. point to the library.
  671.  
  672. The ResetBusError will repair the bus error vector in case it was messed
  673. up by a program. It should be run WITHOUT an active debugger, or the result
  674. will be worse, not better. An application for this program is to restore
  675. the correct bus error handler after having used the "SoftBoot" program or
  676. "SetCPU FastROM" or "CPU FastROM". Note that the latter two are obsolete
  677. and replaced by MuFastROM.
  678.  
  679.  
  680. Release 0.34.1
  681. --------------
  682.     I'm pretty happy with the 0.34 how it is now, I haven't found new
  683.     bugs. This doesn't mean there are none, though. (-;
  684.  
  685.     New in this release:
  686.  
  687.     - Updated MuGuardianAngel a bit. The "hit" messages are now more
  688.       informative and contain more detailed information about the
  689.       cause of the hit, as for example which memory chunk was released
  690.       etc... Thanks to Simon for the hint.
  691.     - Added a new program "MuLink" to the MuTools. This is a shell-only
  692.       developer tool for automatic "self-protection" of software. A
  693.       program that gets "MuLink'd" will get its code (or other selected)
  694.       segments automatically write protected. This is most important 
  695.       for software that has to run on critical systems, as BBS's 
  696.       and the like. MuLink is a post-processing tool much like ATOM.
  697.       More about this tool in its documentation.
  698.     - Added a "MuGuardianOff" icon.
  699.     - Updated the documentation.
  700.     - Included E developer files, thanks to Daniel Kasmeroglu. 
  701.  
  702.  
  703. Remaining problems:
  704.     
  705.     - The usual ppc.library problem. Not about to be fixed.
  706.     - The library still refuses to work correctly on an Appollo 75Mhz
  707.       060EC board, I don't know why. TTx setup of this board is now
  708.       supported correctly, but this doesn't seem to help. Wierd.
  709.  
  710. Release 0.34
  711. ------------
  712.     Sigh, the 0.33 DMA logic was still buggy....
  713.  
  714.     - Fixed (another) bug in CachePostDMA(). The routine failed to
  715.       check the CPU AttnFlags correctly and hence did not restore
  716.       the cache mode to copyback. This could have been resulted in
  717.       slowdown of your machine, and hands of several MuTools.
  718.     - Removed all references to the 68040 and 68060.library. This
  719.       will allow a possible future 680x0 library to use the 
  720.       mmu.library to build its MMU tree instead of implementing this
  721.       function a second time.
  722.  
  723. I M P O R T A N T:
  724.  
  725. THIS MEANS THAT ALL THE MUTOOLS *MUST* BE RUN  A F T E R  SetPatch.
  726.  
  727. The only exception to this rule is MuMove4K.
  728.  
  729. Please DO NOT run the MMURemapTest with the cybscsi or cybppc.device. Both
  730. devices are not designed to allow memory remapping (not my fault). In worst
  731. case, they will trash your hard disk!!!
  732.  
  733.  
  734. Thanks goes to Ulrich Falke for helping me to find these bugs, and 
  735. furthermore to Michaela Prüß for supplying the includes and protos for the 
  736. vbcc compiler!
  737.  
  738. Release 0.33
  739. ------------
  740.     Outch, the 0.30 was buggy!
  741.  
  742.     - Fixed a bug in the GetPageProperties() routine for the 030 and
  743.       020 support code. The cache control functions overwrote an 
  744.       important CPU register and therefore crashed MuForce.
  745.     - Fixed a bug in the DMA control logic. Outch! This really broke
  746.       things!
  747.     - Fixed a bug in the MMU table rounding logic. Fixed one overflow
  748.       problem that makes the procedure hang on some machines. 
  749.       Additionally, I forgot to merge adjacent property nodes here.
  750.     - I must have been crazy to remove the PROTECT option in MuFastROM.
  751.       Fixed!
  752.     - MuFastZero OFF improved, and the FORCENATIVE flag was broken
  753.       completely.
  754.     - MuGuardianAngel showed a few bogus exceptions on startup, depends
  755.       on the system configuration. TRSaferPatches caused this, fixed.
  756.     - Added the FixCybAccess workaround. It fixes - or actually 
  757.       works around - a really bad design fault of the cybscsi.device.
  758.       More on this in its readme.
  759.     - Changed the SegTracker output style of MuForce and MuGuardianAngel
  760.       to the Enforcer style. This is most useful for tools interpreting
  761.       these lines.
  762.  
  763. Thanks to all the nice folks that reported bugs, and sorry for the 
  764. inconvenience about all the bugs.
  765.  
  766. This distribution contains again a "mmu.library_debug". In case you encounter
  767. problems, please rename this to "mmu.library", install "Sushi" or "Sashimi"
  768. with a *LARGE* I/O buffer and run the tests again. Alternatively, connect
  769. a terminal to the serial port, 9600 baud, 8 bit, 1 stop bit, no parity.
  770.  
  771. Please collect the output and sent it to my email address. This will help 
  772. me a lot debugging the library.
  773.  
  774. -----> When reporting bugs, PLEASE PLEASE let me know:
  775.  
  776. o) About which version of the library you're running. I might have sent
  777. some of you an updated version.
  778. o) About which processor your system is running on.
  779. o) A MuScan output.
  780. o) Which SCSI/IDE device you're using.
  781.  
  782. In case you see a crash:
  783.  
  784. o) Please write down the guru number.
  785. o) Try to reproduce the crash, try to find out which program causes the
  786. crash. This means that you should try to edit your startup sequence and to
  787. remove patches from there until the crash disappears. You don't need to
  788. strip the startup-sequence permanently, but just to let me know which
  789. program causes the incompatibility.
  790.  
  791. Please understand that a "It won't work on my computer" doesn't help me 
  792. much to fix the problem. Try to be as concrete as possible, this will 
  793. increase the propability enourmously that bugs get fixed. (-;
  794.  
  795. A special note about the 0.3x releases:
  796.  
  797. I introduced a new guru, namely "AN_PostSetup 0x3e000015". In case you see
  798. this specific guru, let me know which program caused this.
  799.  
  800.  
  801. A special note about MuGuardianAngel:
  802.  
  803. This program is NOT compatible with PoolMem. Try not to install PoolMem on
  804. top of this, this won't work. MuGuardianAngel will be smart enough to cancel
  805. PoolMem if it is running, but it is not smart enough to prevent its 
  806. installation.
  807.  
  808.  
  809. A special note about "version" and related utilities aka "verscheck":
  810.  
  811. These tools OPEN the libraries in question. Hence, if you run "version"
  812. on a - possibly existant - 68040old.library, it will open this library and
  813. re-install a MMU table on top of the already loaded table. Either do
  814. not try this or remove the 68040new.library and the 68040old.library from
  815. your LIBS: drawer.
  816.  
  817.  
  818. A special note about "MMUCacheTest": 
  819.  
  820. If this program hangs on your system, please report this. Furthermore, please
  821. run it *AGAIN*, but this time with the "NOMMU" option on the command line
  822. and *WITHOUT ANY* tools that require the mmu.library. It would be best to
  823. boot without startup-sequence, run "SetPatch" by hand and then immediately
  824. "MMUCacheTest DH0: nommu".
  825.  
  826.  
  827. Release 0.30
  828. ------------
  829.     Ouh, just too many changes to mention:
  830.  
  831.     - Added tags to setup the MMU table layout, as the page size,
  832.       the depth of the MMU tree.
  833.     - Added functions to get and set some control values of the
  834.        MMU contexts.
  835.     - Added page access exception handler.
  836.     - CachePre/PostDMA patches are now always installed since 68020
  837.       and 68030 based systems need the logical -> physical trans-
  838.       lation as well.
  839.     - Reworked the mmu.library memory management.
  840.     - Fixed several bugs in the MuForce program, did not handle ROM
  841.       remapping correctly.
  842.     - MuFastRom and MuFastZero reworked a bit. MuFastZero OFF did
  843.       not work. Added more options for both tools.
  844.     - Added a new debugging tool: MuGuardianAngel. Some sort of
  845.       memory protection that keeps free memory from getting over-
  846.       written by faulty programs.
  847.     - Added more options to MuSetCacheMode.
  848.     - MuMove4K moves now the lowest 32K (and is hence misnamed). This
  849.       avoid trouble with large MMU table sizes on 68030/68020 based 
  850.       systems and pre-allocates memory for an "oxypatcher" type tool.
  851.     - Added MuLockLib tool, check the readme.
  852.     - ....
  853.  
  854.  
  855. Release 0.27
  856. ------------
  857.     - Fixed a bug in the task scheldurer.
  858.     - Added a second explicit cache flush for ColdReboot()
  859.     - Fixed a bug in the branch cache flush of the '060... Sorry!    
  860.     - Tested the library for public remapped memory... Works!
  861.     - Tested the library for private MMU trees... Works!
  862.  
  863.     - Since the 0.27 works now within its specifications, this will
  864.       be the last 0.2x release. We're going to 0.30 now.
  865.  
  866. Release 0.26
  867. ------------
  868.  
  869.     - Fixed a bug in the exception handling, forgot to restore a6.
  870.     - Fixed the return value of RebuildTree(). It's now TRUE on
  871.       success, not DOSTRUE.
  872.     - Fixed a bug in the table builder, merged sub-tree were released
  873.       incorrectly.
  874.     - Added the WithoutMMU() LVO entry.
  875.     - Removed the AllocLineMem() LVO, this one was useless.
  876.  
  877. Release 0.25
  878. ------------
  879.  
  880.     - Debugged 060 exception handler again. Found only one bug, ROM
  881.       emulation was broken.
  882.     - Enhanced AbsExecBase accesses - does no longer block interrupts
  883.       unnecessary.
  884.     - Fixed parts of the exception handler to read the faulty instruction
  885.       from the correct function code space.
  886.     - Added a complicated test for the EC030 processor that should
  887.       finally work.
  888.     - Enabled the MMULib internal exception handler test.
  889.     - Removed all accesses to the ppc.library and reserved entries.
  890.       PPC.lib compatibility is no longer an issue for me. The MMU.lib
  891.       is WarpOs-compatible, though, as long as the system isn't 
  892.       infected by Ralph's "software".
  893.     - Added a safety test in the MMUCacheTest program to avoid
  894.       hangs.
  895.  
  896. Release 0.24
  897. ------------
  898.  
  899.     - Fixed the 030/851 exception handler, especially the emulation
  900.       of instruction access of a possibly invalidated zero page,
  901.       now really, *BIG* thanks to Dave!
  902.     - MuForce does no longer ignore a remapped ROM. (Oops!)
  903.     - MuForce does no longer touch the mapping of the fspace
  904.       unless told to do so.
  905.     - Fixed the assembler includes and autodocs, thanks to Tilman!
  906.     - The context management of the library does no longer
  907.       reset the remap destination in case the memory remap flag
  908.       is not included in the mask settings. (Oops!)
  909.     - Fixed the MMU table builder for MMU tables using more than
  910.       32K entries.
  911.     - The startup code selects now a better page layout for 030/851
  912.       processors.
  913.     - MuForce tries now to re-use an already relocated vector base
  914.       if possible.
  915.     - Tiny speedup in the "InstallDescriptor" routine could speed up
  916.       MMU table building. There's room for more speedups, though.
  917.     - Added a "nommu" flag for the MMUCacheTest program to check    
  918.       your HD without the mmu.library. If this flag is used, the
  919.       program *MUST* be run without the mmu.library currently loaded.
  920.  
  921. Related fixes of COP (release 1.73, not included in this distribution):
  922.     - Fixed emulation of instruction access to the zero-page.
  923.     - Fixed the RestoreVBR option.
  924.     - Fixed the MMU disable mechanism on startup.
  925.  
  926. Special thanks goes to Dave "Ragman" for finding a lot of bugs in the 0.21
  927. release.
  928.  
  929. -----------------------------------------------------------------------------
  930.  
  931. Compatibility warnings and bad software:
  932.  
  933. - The MMU tables generated by the "CPU FastROM" command, an official CBM tool,
  934. are simply wrong if run on a 030 processor. Chip memory is marked as
  935. "cacheable", which is plain wrong. Already spoke to Michael Sinz who agrees
  936. in that point. Don't use it, run "MuFastRom" instead.
  937.  
  938. - The MMU tables build by "SetCPU FastRom" are not very well suited for 
  939. MuForce. The MMU library will replace the table layout by something more
  940. adapted.
  941.  
  942. Since these programs may install a "bogus" exception vector, you shouldn't
  943. run both programs with the "FastROM" option. If you absolutely want to do, 
  944. run them *before* installing any MMU.lib related program and COP - remember, 
  945. you have been warned. "MuFastROM" will do better once the library is finished.
  946.  
  947.  
  948. - CMQ060.lha from the Aminet: This program uses the MOVE16 instruction to
  949. "speed up" the copy mem routines of the Os. Besides that the speedup is
  950. minimal, you should be informed that this instruction is not fully 
  951. supported by the Amiga hardware. A MOVE16 into the chip memory could yield
  952. to "strange and wonderful things", and may or may not work. Its burst
  953. accesses simply don't fit into the DMA access mechanism of the Amiga 
  954. custom chips. (Note that no other instruction will try burst accesses
  955. into non-cacheable memory!)
  956. Moreover, if a MOVE16 crashes, the mmu.library is out of buisiness, it will 
  957. simply guru. Moreover, due to a firmware bug of the '040, a MOVE16 on a
  958. system using virtual memory might be unreliable and cause undesired side
  959. effects. Do not run this program!
  960.  
  961. MOVE16 is one of the non-supported instructions in an Amiga system, others
  962. are TAS, CAS and CAS2 (which are of little use in a single processor system).
  963.  
  964. For more detailed information of MOVE16, check either the enforcer.guide or
  965. the motorola documentation, I'm not making this up, and this is not 
  966. mmu.library related.
  967.  
  968. Known Bugs:
  969. -----------
  970.  
  971.     The MMU table manager rebuilds currently the MMU tables for a
  972.     complete memory block even if only a minor sub-block was changed.
  973.     Therefore, it may take longer to build the MMU table than absolutely
  974.     required. I decided not to change this behaiviour because it
  975.     keeps the mmu tables clean and optimized and avoids fragmentation.
  976.  
  977.     The MMU library builds currently 68030 MMU tables with the
  978.     REPAIRABLE flag set less efficient than it could. However, it 
  979.     was felt that a consistent table layout is more helpful than the
  980.     (minimal) speedup.
  981.  
  982.     The library does not yet contain a workaround for a 040 firmware
  983.     bug: If an illegal, line A, chk or unimplemented floating point
  984.     instruction is located at the last 16 bits of a page and the next
  985.     page is not available, the 040 generates an access fault instead
  986.     of the proper exception. The fault address is the address of the
  987.     missing page, and the PC points to the instruction in the preceeding
  988.     page. This doesn't matter too much currently, it might become
  989.     relevant in a VM system.
  990.  
  991.     The library does not provide the MOVE16 instruction of the '040 and
  992.     '060. See above for details. It does not work around the MOVE16
  993.     firmware bug causing loss of cached data on MOVE16's into invalid
  994.     memory, and it reacts with a guru in case a MOVE16 generates an
  995.     access fault.
  996.  
  997.  
  998. These bugs will be fixed within the next releases of the library, including
  999. all the other bugs you may find.
  1000.     
  1001. -----------------------------------------------------------------------------
  1002.  
  1003. Special thanks goes to:
  1004.  
  1005. -Ralph Babel for giving information about the CachePreDMA/CachePostDMA
  1006.  functions and for some internals allowing me to write the MuOmniSCSIPatch.
  1007. -Carsten Schlote for starting development of a mmu.library aware 68060.lib.
  1008. -Michael Sinz (a real BIG thank you!) for discussing a lot of details of
  1009.  CachePreDMA/CachePostDMA, for sending me the sources of these functions
  1010.  in his 68040, and especially - and that's really great - for making the
  1011.  Enforcer sources available and for allowing me to reuse the exception
  1012.  handler of the Enforcer. This will happen in one of the next releases.
  1013. -Bjoern Schmidt for allowing me to run some tests on his 060 and for
  1014.  keeping several afternoons free for me.
  1015. -All the testers for running tests and sending me detailed information about
  1016.  their systems.
  1017.  
  1018. Thank you to all of you, this project won't clearly possible without your
  1019. support!    
  1020.  
  1021. -----------------------------------------------------------------------------
  1022.  
  1023. What is this:
  1024. -------------
  1025.     The mmu.library provides functions for MMU related operations
  1026.     as write- or read-protecting certain areas of memory for a
  1027.     given set of tasks, or marking memory regions as "swapped"
  1028.     virtual memory support. It offers an abstraction level on top
  1029.     of the actual MMU and a unified interface for MMU purposes.
  1030.  
  1031.     The MMU lib does NOT implement virtual memory, that's the purpose
  1032.     of another library - the memory.library. There's no much reason why
  1033.     any application except the memory.library and probably some debugging
  1034.     tools should call this library directly. The memory.library functions
  1035.     on top of this library should suffer for "all day purposes".
  1036.  
  1037.     The goal of the mmu.library is to provide an "abstraction layer" on
  1038.     top of the hardware, to allow programs to make use of the memory
  1039.     management hardware of the more advanced members of the MC68K
  1040.     processor family. Programs using the functions of the mmu.library
  1041.     do not need to modify the MMU tables directly and hence will not
  1042.     conflict with each other. The mmu.library interface provides all
  1043.     necessary functions to do that. This will allow programs like
  1044.     Enforcer and VMM to cooperate nicely with each other, provided both
  1045.     use this library.
  1046.  
  1047. Since writing the mmu.library is a tough job, I need your help!
  1048.  
  1049. Currently, only two systems are available right here, a MC68030 40Mhz
  1050. ad a MC68040 33Mhz. While this is better than before, I still need your
  1051. help since the library is supposed to support all members of the MC68K
  1052. family (the 68851, 68040 and 68060 MMUs). 
  1053. Since I don't have all these systems available, I need your
  1054. help - writing system software without being able to debug is "a bit" 
  1055. tricky.
  1056.  
  1057.  
  1058. What can I do as a non-developer:
  1059. ---------------------------------
  1060.  
  1061. Testing! Check the documentation of the programs within the documentation,
  1062. especially what you find the "MuTools" drawer, and lemme know how it goes.
  1063.  
  1064. More shell-based tests are in the "Shell_Only" drawer:
  1065.  
  1066. I) First test
  1067. --------------
  1068.  
  1069. Please run the MMUCacheTest program, too. It takes one argument, the
  1070. name of a hard disk. Don't worry, it won't harm your HD, it will simply
  1071. read sectors from it to test some critical MMU.library functions.
  1072.  
  1073. Please perform this test with as many "disk-like" devices as you can, i.e.
  1074. hard disks, CD Roms, SCSI and IDE devices of various kinds.
  1075.  
  1076. Here's an example run:
  1077.  
  1078. 1.SYS:> MMUCacheTest DH0: <RETURN>
  1079.  
  1080. MMUCacheTest 0.25 (14.03.99) © THOR.
  1081. Internal use only, no commercial use.
  1082. Initial read, calculate checksum.
  1083.  
  1084. Running the initial device test.
  1085. This test checks whether the connected device works reliable.
  1086. It does NOT check the MMU code which is not needed for this
  1087. initial run.
  1088. This test SHOULD NOT fail. In case it does, your device or
  1089. host adapter is broken, but not the MMU logic.
  1090.  
  1091. The initial test passed.
  1092.  
  1093. Running the real test. If this test fails, something is wrong
  1094. with the CachePreDMA/CachePostDMA logic. In this case, please
  1095. sent me an EMail so I can fix it.
  1096. The MMU cache test passed. Run 165329 RAM accesses.
  1097.  
  1098.  
  1099. In case any of the tests fail, or you see crashes, please let me know.
  1100. THIS IS AN IMPORTANT TEST. If anything fails here, the future mmu.library
  1101. might trash disk input.
  1102.  
  1103. If the tests pass, check the number of RAM accesses shown in the last line
  1104. of the output. This number *should* be larger than zero. If it's not, then
  1105. the test did effectively nothing. Please let me know in this case either,
  1106. I'll try to invent a more effective test in this case.
  1107.  
  1108.  
  1109. II) Second test
  1110. ---------------
  1111.  
  1112. Please run the MuContextTest program. It should not crash, but should
  1113. output the following:
  1114.  
  1115. 8.VIF:MMULib> Shell_Only/MuContextTest
  1116. A silly test.
  1117. A silly test.
  1118. B silly test.
  1119. C silly test.
  1120. D silly test.
  1121. E silly test.
  1122. F silly test.
  1123. G silly test.
  1124. H silly test.
  1125. I silly test.
  1126. J silly test.
  1127.  
  1128.  
  1129. This test checks whether the library context switch routine works correctly.
  1130. This is most important for the 68020/68851 since it is most sophisticated
  1131. for this hardware configuration.
  1132.  
  1133.  
  1134. III) Third test
  1135. ---------------
  1136.  
  1137. Please run this test LAST since it can't be aborted. The program is run
  1138. with one parameter, the name of a temporary file. Please DO NOT use a file
  1139. on the RAM or RAD since this won't test much, and DO NOT use the floppy
  1140. drives for the same reason. The optimal choice is an external medium like a
  1141. ZIP or a JAZ drive. This test checks mainly the device driver of your hard-
  1142. disk whether it is written MMU conformal or not. Users of the omniscsi.device
  1143. (the Guru ROM) should install the "MuOmniSCSIPatch" or the answer will be
  1144. "No".
  1145.  
  1146. Please run the test as follows:
  1147.  
  1148. 1.SYS:> MuRemapTest SYS:TempFile
  1149.  
  1150. The program will print the result on the screen.
  1151.  
  1152.  
  1153. If this test succeeds, the program will attempt to remap free exec memory
  1154. to a new position and builds a new memory pool. This memory will therefore
  1155. have different physical and logical addresses. Please try now whether your
  1156. system remains stable, but do not yet run MuGuardianAngel as it does not yet
  1157. support memory remapping.
  1158.  
  1159. The program can't be aborted since the remapped memory can't be released
  1160. if parts of it got allocated.
  1161.  
  1162.  
  1163. What can I do as developer:
  1164. ---------------------------
  1165.  
  1166. I'm still willing to give away the sources of the library, provided that
  1167.  
  1168. a) you keep them private and don't give them away (really!)
  1169. b) you help me debugging the library by using them.
  1170.  
  1171. They are no longer included in the "standard" distribution because that
  1172. would enlarge the archive unnecessary for most testers. In case you're
  1173. interested, just sent me a note.
  1174.  
  1175. Under the same restrictions, the MuGuardianAngel sources are available.
  1176.  
  1177.  
  1178.  
  1179. What about joining the mmu.library development group? This is just a couple
  1180. of people contributing to this library by writing code and exchanging their
  1181. wisdom by EMail. It's a non-profit organization that works on the development
  1182. of this library. If, whenever, this library becomes a commercial product, 
  1183. you'll get paid, of course. However, the current library, as it is, is planned
  1184. to be freeware, so don't expect money. It doesn't look like there's currently
  1185. a market for this library project, unfortunately. 
  1186.  
  1187. Contact me at thor@math.tu-berlin.de if you want to join this group.
  1188.  
  1189.  
  1190. What can be done just now is to run this library on your machine and find
  1191. and correct bugs. As I said, I haven't tested the 68851 and the 68060
  1192. parts at all. 
  1193.  
  1194. You might also want to develop software for the library. You find the
  1195. required includes and autodocs within this archive, as well as example
  1196. sources. In case you need support, just contact me.
  1197.  
  1198. There are a lot of library functions that require a bit more testing:
  1199.  
  1200. - All the functions that bypass the abstraction layer:
  1201.  
  1202.     GetPageProperties(),SetPageProperties(),PhysicalPageLocation()
  1203.  
  1204. - Remapping of memory and adding this memory to the exec memory pool.
  1205. - Building private contexts and swaps of the MMU tables on task swaps.
  1206. - SWITCH and LAUNCH type exception handlers.
  1207.  
  1208. I haven't been able yet to run all required tests, sorry. 
  1209.  
  1210.  
  1211. What is in this distribution:
  1212. -----------------------------
  1213.  
  1214. Autodocs:
  1215.     The preliminary version of the autodocs of the mmu.library and
  1216.     the memory library, as well as a file describing some planned
  1217.     implementation details.
  1218.  
  1219. Include:
  1220.     The includes for a C compiler as well as the ".fd" file for the
  1221.     library functions written so far. 
  1222.  
  1223. C_Sources:
  1224.     C sources of sample programs. All programs that are distributed
  1225.     under the THOR-Software licence are published here. The
  1226.     sources of MuForce *are not* available because they are partially
  1227.     copyrighted by Michael Sinz.
  1228.  
  1229. MuTools:
  1230.     Contains an increasing collection of programs that make use of 
  1231.     the MMU. For details, check their guides in this drawer.
  1232.  
  1233. Shell_Only:
  1234.     A couple of programs that can be run from the shell only, as there
  1235.     are:
  1236.  
  1237.     MMUCacheTest:
  1238.         Reads from HD, partially non-cache aligned to check whether
  1239.         boundary pages of the DMA buffer are correctly marked as non-
  1240.         cacheable. See above for how the test looks like.
  1241.  
  1242.     SCSIDMATest:
  1243.         Checks whether the hard disk driver uses CachePreDMA/CachePostDMA
  1244.         consistently. See above for the test. The source is included.
  1245.  
  1246.     TestMMU:
  1247.         This program is purely for debugging purposes. If you run it,
  1248.         you won't see any specific action. It simply opens the library
  1249.         manually and executes the library init function in the task
  1250.         context of the calling program. Hence, this program can be used
  1251.         to step thru the lib-init function with a standard debugger
  1252.         without the need to catch "ramlib".
  1253.         If you still discover bugs and want to try, then load this
  1254.         program into a debugger of your choice, and step thru it.
  1255.  
  1256.     PrintTTX:
  1257.         Prints the transparent translation registers, without using
  1258.         the library. Sometimes required by me if the library fails
  1259.         completely.
  1260.  
  1261.     ClearTTX:
  1262.         Clears the TTx registers. This is a test whether a certain
  1263.         board making use of an overclocked LC060 runs with a pure
  1264.         MMU setup.
  1265.  
  1266.     PrintBusError:
  1267.         Prints the location of the access error handler. This should
  1268.         point to the library in case it is installed.
  1269.  
  1270.     ResetBusError:
  1271.         Resets the bus error handler (! Not to be confused with the
  1272.         access error, this is something different if the library is
  1273.         running) to its system default. This tool MUST be run very
  1274.         early, with no debuggers active, or the bus error will be
  1275.         completely messed up.
  1276.  
  1277.     MuContextTest:
  1278.         Checks the MMU context switches by installing a task with
  1279.         a private context. The mmu.library has hence to switch 
  1280.         between two different MMU tables. See above for details
  1281.         how to run this test.
  1282.  
  1283.     MuRemapTest:
  1284.         Checks support of remapped memory by device drivers and
  1285.         the remaining system. Must be run with a temporary file
  1286.         on the harddisk to be checked. THIS TEST WON'T RETURN!
  1287.  
  1288.     CheckFPU:
  1289.           This program prints the version number of a 68040 FPU if 
  1290.         one is available. Two versions exist, the V40 "original" 
  1291.         which is very buggy and the V41 "revised" with less bugs. 
  1292.         The 68040.library supports currently both, with lots of 
  1293.         workarounds for the V40. Please contact me in case you 
  1294.         find a V40 edition in your Amiga.
  1295.  
  1296.     
  1297. Known bugs and problems of this implementation:
  1298. -----------------------------------------------
  1299.  
  1300. Things that require testing:
  1301.  
  1302.     - TTx register parsing updated, again. Should work fine with all the
  1303.       printouts I've collected, but you may still want to test it.
  1304.     - 68851 code likely untested, but I'm getting better. 
  1305.       I NEED YOUR HELP!
  1306.     - GetPageProperties/SetPageProperties are likely tested by the
  1307.       MuGuardianAngel program.
  1308.     - Page access exception handlers only likely tested by 
  1309.       MuGuardianAngel.
  1310.  
  1311. Things not yet implemented:
  1312.  
  1313.     - Patches for ppc libraries due to missing support. The
  1314.       ppc.library will remain unsupported, if you're the owner of
  1315.       a PPC board, run WarpOs, which is compatible.
  1316.  
  1317. Things the current design does not allow:
  1318.  
  1319.     - The MAPP_USED and MAPP_MODIFIED flags are not kept consistent
  1320.       by the library except for MAPP_SINGLE pages. I consider this
  1321.       as a minor problem since single page mode is required for
  1322.       virtual memory anyways.
  1323.     - MMU tables using the function codes. The amiga design shouldn't
  1324.       allow this anyways, but I don't know whether there's a board
  1325.       that makes use of them. (Doesn't look like, though).
  1326.     - Boards with two different MMU's on board. I've heard some
  1327.       rumours that there are actually 68040 boards with an additional
  1328.       68851. 
  1329.  
  1330. Debugging:
  1331. ----------
  1332.  
  1333. Yes, that's a problem of its own. Obviously, the MMU library uses some
  1334. "heavy magic" supervisor code which is not available for a standard monitor.
  1335. Even though the DevPac "MonAm" is a nice and powerful debugger, it's not
  1336. powerful enough for these tricks. There's currently - up to my knowledge -
  1337. only one debugger that can do this for you, and that's my own... (-;
  1338.  
  1339. Check the Aminet and my web-page for COP, then read the documentation. If,
  1340. after reading, you STILL want to use it, you're the right guy for this
  1341. job... (-;
  1342. COP might be setup to load the symbols of the library, to help you a bit.
  1343.  
  1344. The latest available version of COP is 1.73. Try to get the latest, if 
  1345. possible.
  1346.  
  1347. Recommended reading:
  1348. --------------------
  1349.  
  1350. The following books are recommended reading:
  1351.  
  1352.  
  1353. Motorola 68030 Enhanced 32-bit Microprocessor User's Manual    
  1354.     MC68030UM/AD Rev.3
  1355.  
  1356. Motorola 68040 User's Manual                    
  1357.     M68040UM/AD Rev.1
  1358.  
  1359. Motorola 68060 User's Manual                    
  1360.     M68060UM/AD Rev.1
  1361.  
  1362. Motorola M68000 Family Programmer's Reference Manual        
  1363.     M68000PM/AD Rev.1
  1364.  
  1365. Amiga Hardware Reference Manual, 3rd ed.
  1366.     Addison-Wesley Publishing Company, Inc.
  1367.     ISBN 0-201-56776-8
  1368.  
  1369. Amiga ROM Kernal Reference Manual, 3rd ed., Volume "Libraries"
  1370.     Addison-Wesley Publising Company, Inc.
  1371.     ISBN 0-201-56774-1
  1372.  
  1373. The Amiga Guru Book, 2nd Ed.
  1374.     Ralph Babel, Taunusstein 1989,1993
  1375.  
  1376. Additional sources:
  1377.     The Amiga Developer CD V1.1 
  1378.  
  1379.     The Enforcer.guide.
  1380.  
  1381.     Michael Sinz's documentation in the AmigaMail, on the DevCD 1.1.
  1382.  
  1383. Final words:
  1384. ------------
  1385.  
  1386. The mmu.library and the memory library will be my last project for the Amiga. 
  1387. It depends a bit on what happens with the Amiga in the next two years whether 
  1388. a PPC version of this library is required or not; hence, after all, this
  1389. can't be much more than a toy project that came several years too late.
  1390.  
  1391. So long,
  1392.     Thomas
  1393.